Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GoServer] Generate non-required parameters as pointers (nil-able) #19149

Conversation

phil-bugdahn-hs
Copy link

@phil-bugdahn-hs phil-bugdahn-hs commented Jul 11, 2024

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

This PR fixes #19169

The problem is that, using an OpenAPI spec that specifies a non-required query param, the go-server generator will generate the server handler taking that parameter as a value rather than a pointer. By doing this, it is not possible to tell in the handler whether the parameter was actually passed or if it is just a default value. By using a pointer the parameter value will be nil if not passed by the client. This PR should fix that issue.

@wing328
Copy link
Member

wing328 commented Jul 15, 2024

@phil-bugdahn-hs thanks for the PR. can you please review the test failure when you've time?

https://github.com/OpenAPITools/openapi-generator/actions/runs/9941343559/job/27462431755?pr=19149

@wing328
Copy link
Member

wing328 commented Jul 15, 2024

cc
@antihax (2017/11) @grokify (2018/07) @kemokemo (2018/09) @jirikuncar (2021/01) @ph4r5h4d (2021/04) @lwj5 (2023/04)

@phil-bugdahn-hs
Copy link
Author

Hi @wing328, thanks for your response. I think I have resolved the test issue.

@wing328
Copy link
Member

wing328 commented Jul 16, 2024

@phil-bugdahn-hs thanks again for the PR.

Is it correct to say that this is a breaking change (without fallback)?

@lwj5
Copy link
Contributor

lwj5 commented Jul 16, 2024

Hi @phil-bugdahn-hs, I think the problem has been discussed in #16980 and #17051. You may want to review the pointers there.

Is this PR trying to do what is stated in #17321?

Required and Nullable are orthogonal concepts. I don't think this PR should be merged

@phil-bugdahn-hs
Copy link
Author

Closing as per disccusion in the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG][GO] Query parameters that are not required should be generated as pointers in go-server
3 participants